(Doc+) Clarify dimension field requirements for time_series aggregation #119442
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
👋 howdy, team! This PR adds a note explaining that time series indices require: - index.mode set to "time_series" - at least one dimension field with time_series_dimension: true - a routing_path array listing those dimension fields Without these settings, the time_series aggregation may return empty buckets or behave unexpectedly. By emphasizing the dimension field requirement, we help users configure their time series indices correctly and see meaningful aggregation results.
jihyunjeongme
added
>enhancement
>docs
|
Documentation preview: |
|
@jihyunjeongme please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation. |
|
Pinging @elastic/es-docs (Team:Docs) |
elasticsearchmachine
added
the
external-contributor
shainaraskas
reviewed
Jan 2, 2025
docs/reference/aggregations/bucket/time-series-aggregation.asciidoc
Outdated
Show resolved
Hide resolved
leemthompo
reviewed
Jan 29, 2025
docs/reference/aggregations/bucket/time-series-aggregation.asciidoc
Outdated
Show resolved
Hide resolved
Co-authored-by: shainaraskas <[email protected]>
leemthompo
approved these changes
Jan 29, 2025
leemthompo
added
auto-backport
|
run docs-build |
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
leemthompo
added a commit
to leemthompo/elasticsearch
that referenced
this pull request
Jan 29, 2025
…on (elastic#119442) * (Doc+) Clarify dimension field requirements for time_series aggregation 👋 howdy, team! This PR adds a note explaining that time series indices require: - index.mode set to "time_series" - at least one dimension field with time_series_dimension: true - a routing_path array listing those dimension fields Without these settings, the time_series aggregation may return empty buckets or behave unexpectedly. By emphasizing the dimension field requirement, we help users configure their time series indices correctly and see meaningful aggregation results. * Apply suggestions from code review Co-authored-by: shainaraskas <[email protected]> --------- Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: shainaraskas <[email protected]> (cherry picked from commit e120739)
leemthompo
added a commit
that referenced
this pull request
Jan 29, 2025
leemthompo
added a commit
that referenced
this pull request
Jan 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
👋 howdy, team!
This PR adds a note explaining that time series indices require:
Without these settings, the time_series aggregation may return empty buckets or behave unexpectedly. By emphasizing the dimension field requirement, we help users configure their time series indices correctly and see meaningful aggregation results.